Allowed title as props for <details>
#3388
Conversation
question if this approach breaks some titles and we have to maintain two options, why do we consider it superior and why do ? let's keep the previous one? also, it's not at all a high priority task to my mind, folks. Unless something is broken now. |
markdown wouldn't be supported when passed as props but I think it would be okay without it too as it's used in just 2 titles to highlight
I think this one needs to be addressed and which we didn't address on pervious pr. |
|
Still, I don't see any clear motivation for this tbh. And still it breaks things in some cases. So, my take - let's postpone / keep it as-is for now. |
| <details> | ||
| <details title="Click and expand to set up the example"> | ||
|
|
||
| ### Click and expand to set up the project |
There was a problem hiding this comment.
The existing header remaining here makes breaks this block
| <details> | ||
|
|
||
| ### What is a "local remote" ? | ||
| <details title=' What is a "local remote" ?'> |
There was a problem hiding this comment.
While it looks alright since the result is trimmed, we should trim out the excess spaces here.
| <details> | ||
|
|
||
| ### Click and expand to set up the project | ||
| <details title="Click and expand to set up the project> |
There was a problem hiding this comment.
Does this PR update all existing <details> blocks? Thanks
This comment was marked as resolved.
This comment was marked as resolved.
|
Reminder:
can we skip addressing the conflict? please please let's be mindful about the bigger priorities |
| ### Click and expand to set up example | ||
| <details title="Click and expand to set up example"> |
There was a problem hiding this comment.
OK just noticed we're postponing this. Just a note that per #3391 these titles should no longer start in "Click for" nor end in "example" (same throughout docs codebase). Thanks
|
Given this is not much of a priority + all the conflicts, should we close it or turn it into an issue? Thanks |
From #3383
Used title as props for
<details>tag.Initially, I only used
titleas props but there are 2-3 particular cases that usecodehighlighting in the title.So, I also added back the first child's text as a fallback if no title is passed as props so that we still can use markdown as well.
Also, previously in this particular case, the code section seems to be parsed as
object objectas wellresulting: https://dvc.org/doc/user-guide/external-dependencies#expand-to-see-resulting-object-object-file
This issue should also be fixed with the pr.
But, if markdown syntax is not so important and the title would be enough then the code implementation of the Details component will be very simple and preferable.